Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add screenshot of sample report to the README #153

Merged
merged 13 commits into from
Oct 23, 2023
Merged

Add screenshot of sample report to the README #153

merged 13 commits into from
Oct 23, 2023

Conversation

spier
Copy link
Contributor

@spier spier commented Oct 21, 2023 •
edited by zkoppert
Loading

Closes #150.

As the visual changes matters here, make sure the review the rendered version of the proposed change too.

Proposed Changes

  • Add screenshot of sample report to the README.
  • Add section title for the "Metrics" information
  • Move sentence about the origins of this project to the intro (the bit about the GitHub OSPO)

Things to consider/review

  • is the screenshot too large? I am mostly concerned about the height of the image.
  • do we like the place in the README where the screenshot appears? could also be moved below the workflow sample if we prefer. As a user I personally like to see first "what will I get when using this" before I learn "how do I use this".
  • so reduce height of the screenshot, we could cut off anything below "this report was generated with". we could also cheat and remove some of the issues from the full list of issues :)

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing

Reviewer

  • Label as either bug, documentation, enhancement, infrastructure, or breaking

@spier spier requested a review from zkoppert as a code owner October 21, 2023 21:09
@spier
Copy link
Contributor Author

spier commented Oct 21, 2023

@Okabe-Junya please take a look.

@Okabe-Junya
Copy link
Contributor

I think it's wonderful!! Thank you for adding such clear screenshots!!

@zkoppert zkoppert added the documentation Improvements or additions to documentation label Oct 23, 2023
zkoppert
zkoppert approved these changes Oct 23, 2023
View reviewed changes
Copy link
Member

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improvements look great! Thanks @spier for putting up this pull request and @Okabe-Junya for reviewing!

@zkoppert zkoppert merged commit 3ade00a into github:main Oct 23, 2023
5 checks passed
@spier spier deleted the add-screenshot-of-output branch October 23, 2023 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zkoppert zkoppert zkoppert approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

feat: Add the result images in the README.
3 participants
@spier @Okabe-Junya @zkoppert